Skip to content

Add Install Gateway Section in Getting Started guide #1673

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 1 commit into from
Oct 20, 2025
Merged

Add Install Gateway Section in Getting Started guide #1673

merged 1 commit into from
Oct 20, 2025
+82 −70

Conversation

dharaneeshvrd
Copy link
Contributor

@dharaneeshvrd dharaneeshvrd commented Oct 2, 2025 •
edited
Loading

What type of PR is this?

What this PR does / why we need it:
Move instructions from the Deploy an Inference Gateway section describing installation of Gateway API CRDs and provider specific GWs in new Install Gateway section.
This also solves the istio getting started guide by reordering the steps since inference pool helm chart requires istio CRDs to be present before installing the chart due to recent change #1381.

Which issue(s) this PR fixes:

Fixes #1649

Does this PR introduce a user-facing change?:

NONE

@netlify Netlify
Copy link

netlify bot commented Oct 2, 2025 •
edited
Loading

✅ Deploy Preview for gateway-api-inference-extension ready!

Name Link
🔨 Latest commit d45209a
🔍 Latest deploy log https://app.netlify.com/projects/gateway-api-inference-extension/deploys/68f634c5ee17cc0008a3b613
😎 Deploy Preview https://deploy-preview-1673--gateway-api-inference-extension.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@k8s-ci-robot k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Oct 2, 2025
@k8s-ci-robot k8s-ci-robot requested review from ahg-g and danehans October 2, 2025 15:29
@k8s-ci-robot k8s-ci-robot added the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label Oct 2, 2025
@dharaneeshvrd
Copy link
Contributor Author

/cc @nirrozenbaum
could you please review this fix?

@kfswain
Copy link
Collaborator

kfswain commented Oct 7, 2025

Hi @dharaneeshvrd thanks for the PR. Are we certain this is broken? Looking at the docs it seems like everything is WAI and all other GW implementations have the install step lower down in the guide.

@dharaneeshvrd
Copy link
Contributor Author

@kfswain Yes currently all GW implementations are having the install step lower down the guide but it seems due to #1381 this recent change, inferencepool helm chart for istio provider requires istio's DestinationRule CRD to be present first. Hence for istio alone moved the installation step before installing the inferencepool helm chart like its being requested in the issue #1649.

@nirrozenbaum
Copy link
Contributor

@kfswain yup, this is certain. see issue #1649 which I opened after following the quickstart guide and hit that issue.

@dharaneeshvrd I think the current change is not the ideal one.
after this change - the section that is called Deploy the InferencePool and Endpoint Picker Extension is now describing how to install Istio using istioctl.

I was thinking about adding a new Sub-Section like Install Gateway which should include the installation of the specific gateway CRDs (and most Gateways also describe requirement for installing Gateway API CRDs).
so the idea is to make a separation between CRDs installation and actual deployment.
(it's kinda the same idea that we install Inference Extension CRDs in one sub-section, and deploy it in the next sub section).

additionally, when doing this change please pay attention to numbering, cause in current change that was missing (see screenshot below):
image

@dharaneeshvrd
Copy link
Contributor Author

Ok If I understood correctly, the guide would have following sections.
Deploy Sample Model Server
Install the Inference Extension CRDs
Install Gateway - New section to add instruction to install Gateway API CRDs and provider specific gateway(CRD & GW itself)
Deploy the InferencePool and Endpoint Picker Extension
Deploy an Inference Gateway - Instruction to deploy Inference Gateway & HttpRoute ...
Remainig section continues as is ...

Hope I can continue with the changes described above.

@nirrozenbaum
Copy link
Contributor

Ok If I understood correctly, the guide would have following sections. Deploy Sample Model Server Install the Inference Extension CRDs Install Gateway - New section to add instruction to install Gateway API CRDs and provider specific gateway(CRD & GW itself) Deploy the InferencePool and Endpoint Picker Extension Deploy an Inference Gateway - Instruction to deploy Inference Gateway & HttpRoute ... Remainig section continues as is ...

Hope I can continue with the changes described above.

yeah, that sounds good 👍🏻

@dharaneeshvrd dharaneeshvrd force-pushed the fix-istio-getting-started-guide branch from af9a1d5 to 1a8e395 Compare October 8, 2025 05:26
@k8s-ci-robot k8s-ci-robot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. and removed size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Oct 8, 2025
@dharaneeshvrd dharaneeshvrd force-pushed the fix-istio-getting-started-guide branch 2 times, most recently from 17151c8 to fe5883f Compare October 8, 2025 05:30
@dharaneeshvrd
Copy link
Contributor Author

@nirrozenbaum Could you please review the changes?

@dharaneeshvrd
Copy link
Contributor Author

@nirrozenbaum Did you get a chance to look at the changes?

@nirrozenbaum
Copy link
Contributor

nirrozenbaum commented Oct 13, 2025 •
edited
Loading

@nirrozenbaum Did you get a chance to look at the changes?

unfortunately not yet due to many holidays.. I should be back to work on Wednesday and then I can prioritize this PR review.

@nirrozenbaum
Copy link
Contributor

/retest

@k8s-ci-robot k8s-ci-robot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Oct 15, 2025
@dharaneeshvrd dharaneeshvrd force-pushed the fix-istio-getting-started-guide branch from fe5883f to 1e0cd6f Compare October 15, 2025 09:07
@k8s-ci-robot k8s-ci-robot removed the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Oct 15, 2025
@dharaneeshvrd dharaneeshvrd force-pushed the fix-istio-getting-started-guide branch from 1e0cd6f to 3872780 Compare October 15, 2025 10:35
@dharaneeshvrd dharaneeshvrd changed the title Fix istio getting started guide Add Install Gateway Section in Getting Started guide Oct 15, 2025
@k8s-ci-robot k8s-ci-robot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Oct 18, 2025
@nirrozenbaum
Copy link
Contributor

@dharaneeshvrd sorry for the delayed review. can you please rebase?
This is an important PR that should be merged after rebase is done.

@dharaneeshvrd
Add Install Gateway section in Getting Started guide
d45209a 
- Move instructions from the Deploy an Inference Gateway section describing installation of Gateway API CRDs and provider specific GWs

Signed-off-by: Dharaneeshwaran Ravichandran <[email protected]>
@dharaneeshvrd dharaneeshvrd force-pushed the fix-istio-getting-started-guide branch from 3872780 to d45209a Compare October 20, 2025 13:10
@k8s-ci-robot k8s-ci-robot removed the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Oct 20, 2025
@dharaneeshvrd
Copy link
Contributor Author

@nirrozenbaum
can you please take a look now?

@nirrozenbaum
Copy link
Contributor

/lgtm
/approve

Thanks for your patience with this PR!

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Oct 20, 2025
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: dharaneeshvrd, nirrozenbaum

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Oct 20, 2025
@k8s-ci-robot k8s-ci-robot merged commit 4e3c419 into kubernetes-sigs:main Oct 20, 2025
10 checks passed
@danehans danehans mentioned this pull request Oct 20, 2025
Open
@danehans
Copy link
Contributor

@dharaneeshvrd @nirrozenbaum this PR only updates the released version of the quickstart guide. The same updates should be implemented in the site-src/guides/getting-started-latest.md guide. I field #1752 to track this issue. @dharaneeshvrd please assign yourself if you have time to fix this issue.

@dharaneeshvrd
Copy link
Contributor Author

Sure I can add a fix for #1752.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@ahg-g ahg-g Awaiting requested review from ahg-g

@danehans danehans Awaiting requested review from danehans

@nirrozenbaum nirrozenbaum Awaiting requested review from nirrozenbaum

Assignees

@nirrozenbaum nirrozenbaum

Labels

approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. lgtm "Looks good to me", indicates that a PR is ready to be merged. size/L Denotes a PR that changes 100-499 lines, ignoring generated files.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

quickstart with Istio fails due to wrong order of steps

5 participants

@dharaneeshvrd @kfswain @nirrozenbaum @k8s-ci-robot @danehans